GET
/
1
/
indexes
/
{indexName}
/
{objectID}
// Initialize the client
var client = new SearchClient(new SearchConfig("ALGOLIA_APPLICATION_ID", "ALGOLIA_API_KEY"));

// Call the API
var response = await client.GetObjectAsync(
  "<YOUR_INDEX_NAME>",
  "uniqueID",
  new List<string> { "attr1", "attr2" }
);
// >LOG
{}

Authorizations

​
x-algolia-application-id
string
header
required

Your Algolia application ID.

​
x-algolia-api-key
string
header
required

Your Algolia API key with the necessary permissions to make the request. Permissions are controlled through access control lists (ACL) and access restrictions. The required ACL to make a request is listed in each endpoint's reference.

Path Parameters

​
indexName
string
required

Name of the index on which to perform the operation.

Example:

"ALGOLIA_INDEX_NAME"

​
objectID
string
required

Unique record identifier.

Example:

"test-record-123"

Query Parameters

​
attributesToRetrieve
string[]

Attributes to include with the records in the response. This is useful to reduce the size of the API response. By default, all retrievable attributes are returned.

objectID is always retrieved.

Attributes included in unretrievableAttributes won't be retrieved unless the request is authenticated with the admin API key.

Response

200
application/json

OK

The requested record.